RoleData

The role object contains meta-data for the role.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

roleId

The role's system ID

-

string

uuid

roleName

The role's name

Y

string

roleSettings

The role's settings

-

string

isHidden

Flag to indicate if the role is hidden

-

boolean

tenantId

The roles's tenant (ID)

Y

string

uuid

*Required elements are only used for API parameters

Usages
  • /API/admin/createRole
  • /API/admin/getAllNonPrivateRoles
  • /API/admin/getAllNonPrivateRolesByTenant
  • /API/admin/getAllPrivateRolesByTenant
  • /API/admin/getAllRoles
  • /API/admin/getAllRolesByUser
  • /API/admin/getRole
  • /API/admin/getRolesByName
  • /API/admin/getRolesForItem
  • /API/admin/updateUserRoles
  • /API2/access/createRole
  • /API2/access/createRoles
  • /API2/access/getAllNonPrivateRolesByTenant
  • /API2/access/getAllRolesByProfileId
  • /API2/access/getRoleById
  • /API2/content/getContentItemSecurityRoles